sdproperty module

class sd.api.sdproperty.SDProperty(APIContext, handle, *args, **kwargs)

Bases: sd.api.sdapiobject.SDAPIObject

Description of property defined by an identifier, a type, and some additional information

getCategory() → sd.api.sdproperty.SDPropertyCategory

Get the category of the property (see SDPropertyCategory)

getClassName() → str

Returns the most specific name of the class this APIObject is

getDefaultValue() → Optional[sd.api.sdvalue.SDValue]

Get the default value of the property

getDescription() → str

Get the description of the property

getId() → str

Get the identifier of the property. The identifier is unique in the current category.

getLabel() → str

Get the label of the property

getType() → Optional[sd.api.sdtype.SDType]

Get the first type of all available types returned by getTypes() (defined for convenience)

getTypes() → sd.api.sdarray.SDArray[sd.api.sdtype.SDType][sd.api.sdtype.SDType]

Get all types supported by this property

isConnectable() → bool

Indicates whether the property is connectable (i.e. if another node’s property can be connected to it)

isFunctionOnly() → bool

Indicates if the property value is only controlled by a function. If so calling getPropertyValue/setPropertyValue is not allowed

isPrimary() → bool

Indicates whether the property is the primary property in its category

isReadOnly() → bool

Indicates whether the property is readonly

isVariadic() → bool

Indicates whether the property is variadic. If True, this parameter will be represented as multiple properties on the instance

release() → None

Releases an APIObject

class sd.api.sdproperty.SDPropertyCategory

Bases: enum.Enum

An enumeration.

Annotation = 0

Input = 1

Output = 2

class sd.api.sdproperty.SDPropertyInheritanceMethod

Bases: enum.Enum

Property value is relative to the node that is connected to this input property

Absolute = 2

RelativeToInput = 0

Property value is relative to the graph containing the node of this input property

RelativeToParent = 1

Property value is not relative